﻿/*
 * DG (DG Gaming Engine)  - API
 * Copyright (C) 2004  Bob Marks (marksie531@yahoo.com)
 * http://code.google.com/p/dng-gaming
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package com.dg.gaming.api.common.msg{
	import nanoxml.XMLElement;
	import com.dg.gaming.api.common.TransmissionException;

	/**
	 * Communication class which is used to send a private message between users.
	 *
	 * @author Bob Marks
	 * @version Alpha 0.2.3
	 */
	public class MsgChatPrivate extends MsgChatClient {

		/**
		     * Constructer for a private message which takes a message and a usernameTo.
		     *
		     * @param chat          Chat message from user.
		     * @param usernameTo    Name of user the chat is going to.
		     */
		public function MsgChatPrivate(chat:String=null,usernameTo:Number=-1,message:XMLElement=null) {
			super(chat,message);

			setUseridTo(usernameTo);
		}

		/**
		     * Flatten this object class to an XML message.
		     *
		     * @see com.dg.gaming.api.common.msg.ITransmittable#flatten()
		     */
		public override function flatten():XMLElement {
			var element:XMLElement=super.flatten();
			element.name=Msg.CHAT_PRIVATE;

			return element;
		}
	}
}